Advanced Regeneration (Beta 1.2)
=====================-----------

Description:
------------

Mutator - Gives all players customizable health, shield, adrenaline and ammo regeneration.


Options:
--------

While configuring Advanced Regeneration (in the "Configure Mutators" GUI), hover the mouse over an option to see it's description.  The following is a list of the available options.

Health Regeneration:

  Health Regen Amount - The amount of health regeneration.  If Health Regen Rate is 0, this is the health gain per second (on average).  (Put 0 to disable health regen.)

  Health Regen Rate - How often (in seconds) to give the Health Regen Amount.  If this is 0, 'smooth regen' will be used (health is given one point at a time).

  Health Regen Max % - The maximum amount of health to regenerate (expressed as % of maximum health).

  Health Regen Timeout - The number of seconds to wait after taking damage before continuing to regenerate health.

Shield Regeneration:

  Shield Regen Amount - The amount of shield regeneration.  If Shield Regen Rate is 0, this is the shield gain per second (on average).  (Put 0 to disable shield regen.)

  Shield Regen Rate - How often (in seconds) to give the Shield Regen Amount.  If this is 0, 'smooth regen' will be used (shield is given one point at a time).

  Shield Regen Max % - The maximum amount of shield to regenerate (expressed as % of maximum shield).

  Shield Regen Timeout - The number of seconds to wait after taking damage before continuing to regenerate shield.

  Wait for Health - Whether or not to wait for health to stop regenerating before regenerating shield.

Adrenaline Regeneration:

  Adren. Regen Amount - The amount of adrenaline regeneration.  If Adrenaline Regen Rate is 0, this is the adrenaline gain per second (on average).  (Put 0 to disable adrenaline regen.)

  Adren. Regen Rate - How often (in seconds) to give the Adrenaline Regen Amount.  If this is 0, 'smooth regen' will be used (adrenaline is given one point at a time).

  Adren. Regen Max % - The maximum amount of adrenaline to regenerate (expressed as % of maximum adrenaline).

  Adren. Regen Timeout - The number of seconds to wait after finishing an adrenaline combo before continuing to regenerate adrenaline.

  Override Adrenaline - Whether or not to force adrenaline to be enabled, even if the game-type or another mutator disables it.

Ammo Regeneration:

  Ammo Regen Amount (%) - The amount of ammo regeneration - expressed as % of maximum ammo, per second (on average; 'smooth regen' is always used).  (Put 0 to disable ammo regen.)

  Ammo Regen Amount for Super-weapons (%) - The amount of ammo regeneration for super-weapons - expressed as % of maximum ammo, per second (on average; 'smooth regen' is always used).  (Put 0 to disable ammo regen.)

  Ammo Regen Max % (Current) - The maximum amount of ammo to regenerate for the current weapon (expressed as % of max ammo).

  Ammo Regen Max % (Other) - The maximum amount of ammo to regenerate for other weapons (expressed as % of max ammo).

  Ammo Regen Timeout - The number of seconds to wait after firing before continuing to regenerate ammo.

  Regen Current Weapon - Whether to regenerate ammo for the current weapon.

  Regen Other Weapons - Whether to regenerate ammo for the weapons other than the current weapon.

  Super Berserk Compatibility Mode - Enable this to use an alternate method of regeneration when the game is in Super Berserk mode, so that weapons don't fill to the maximum instantly.

Randomisation:

  Random Scale Minimum - The minimum Regen Amount (or Rate for ammo regen) multiplier (for randomising regen).  Beware that Health is rounded down to an integer (so 0.99 * 1 health = 0).

  Random Scale Maximum - The maximum Regen Amount (or Rate for ammo regen) multiplier (for randomising regen).  Beware that Health is rounded down to an integer (so 0.99 * 1 health = 0).


Installation:
-------------

Copy the following files to your UT2004\System directory:
- psAdvancedRegen.u
- psAdvancedRegen.int
- psAdvancedRegen.ucl


Usage:
------

Use the "Advanced Regeneration" mutator to enable health, shield, adrenaline and/or ammo regeneration.  (Each type of regeneration can be customized or disabled in the "Configure Mutators" GUI).


Version History
---------------

Beta 1:
- first public release

Beta 1.1:
- Replaced "Ammo Regen Max %" option with "Ammo Regen Max % (Current)" and "Ammo Regen Max % (Other)"

Beta 1.2:
- Added option "Ammo Regen Amount for Super-weapons (%)".  For now, any weapon with a max ammo of < 5 is considered a super-weapon.
- Maybe some minor modifications I've forgotten

Beta 1.3:
- Added option "Super Berserk Compatibility Mode".  Enabling this should fix ammo regeneration with the Super Berserk mutator in, but it may cause other problems.

Author:
-------

Programmed by Steve "PsychoticSteve" Gray (a.k.a. porkmanii)

Advanced Regen was mostly thought up by Bjossi, in this thread on the Atari Forums:
http://www.ataricommunity.com/forums/showthread.php?s=&threadid=382703